Skip to content

Init, fill, and check so empty help cannot ship quietly - #1

Open
AMDphreak wants to merge 1 commit into
mainfrom
feat/init-fill-check
Open

Init, fill, and check so empty help cannot ship quietly#1
AMDphreak wants to merge 1 commit into
mainfrom
feat/init-fill-check

Conversation

@AMDphreak

Copy link
Copy Markdown
Contributor

Summary

Hi! Parse-success on a blank help.sdl was letting people think they had a working Prohelp system when the fields that actually make help useful were still empty.

This PR tries to give authors a loop they can run locally and a ship gate they can opt into:

  • prohelp init writes a shaped schema immediately (questionnaire is optional: --fill or prohelp fill)
  • prohelp check reports missing summaries, discovery URLs, empty sections, and budget slips; --strict fails for CI
  • Reusable workflow .github/workflows/check-schema.yml so other repos can call one job instead of inventing the pipeline
  • SDL example tags are parsed and shown in Text Mode (they used to be ignored)

check still cannot reach into someone else's CI by itself — they add the job. The workflow is the one-liner for that.

Happy to adjust anything that doesn't fit the project's taste.

How to try it

  1. dub build -c executable
  2. prohelp init --name myapp then prohelp check / prohelp check --strict
  3. prohelp fill help.sdl --set summary=Does a thing --set homepage=https://example.com --set docs=https://example.com/docs --set issues=https://example.com/issues
  4. prohelp help.sdl ?

Made with Cursor

Give developers a shaped help.sdl, a questionnaire, and a --strict CI gate (reusable workflow) instead of parse-success on empty docs.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant